Security News
Highlights from the 2024 Rails Community Survey
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
The kleur npm package is a library for formatting terminal text with ANSI colors. It provides a simple and chainable API to style strings that are output to the console with various colors, backgrounds, and text styles.
Coloring text
This feature allows you to apply text color to your console output. The example shows how to color the text green.
const kleur = require('kleur');
console.log(kleur.green('Hello world!'));
Chaining styles
Kleur supports chaining multiple styles together. In this example, the text 'Error!' is styled to be red, bold, and underlined.
const kleur = require('kleur');
console.log(kleur.red().bold().underline('Error!'));
Background colors
You can also set background colors for your text. Here, the text 'Info' has a blue background with white foreground color.
const kleur = require('kleur');
console.log(kleur.bgBlue().white('Info'));
Conditional styling
Kleur allows conditional styling, where you can enable or disable colors based on certain conditions. In this example, the red color is applied only if the environment is not production.
const kleur = require('kleur');
const enabled = process.env.NODE_ENV !== 'production';
console.log(kleur.enabled(enabled).red('Only styled if not in production'));
Chalk is a popular npm package similar to kleur that allows for styling terminal strings. It offers a more extensive API and additional features like template literal support and custom themes, but it is slightly larger in size compared to kleur.
Colors is another package that provides ANSI color formatting for text in the terminal. It extends String.prototype to add color properties, which some developers may find less clean than the functional approach taken by kleur.
Ansi-colors is a lightweight package that focuses on performance. Like kleur, it does not extend String.prototype and has a chainable API, but it has fewer dependencies and is designed to be as minimal as possible.
String.prototype
modificationsOriginally inspired by ansi-colors
. See Credits for more info!
$ npm install --save kleur
const kleur = require('kleur');
// basic usage
kleur.red('red text');
// chained methods
kleur.blue.bold.underline('howdy partner');
// nested methods
kleur.bold(`${ kleur.bgRed.white('[ERROR]') } ${ kleur.red.italic('Something happened')}`);
console.log(kleur.bold.red('this is a bold red message'));
console.log(kleur.bold.italic('this is a bold italicized message'));
console.log(kleur.bold.yellow.bgRed.italic('this is a bold yellow italicized message'));
console.log(kleur.green.bold.underline('this is a bold green underlined message'));
const { yellow, red, cyan } = require('kleur');
console.log(yellow(`foo ${red.bold('red')} bar ${cyan('cyan')} baz`));
console.log(yellow('foo ' + red.bold('red') + ' bar ' + cyan('cyan') + ' baz'));
Toggle color support as needed; kleur
assumes it's always enabled.
const kleur = require('kleur');
// manually disable
kleur.enabled = false;
// or use a library to detect support
kleur.enabled = require('color-support').level;
console.log(kleur.red('I will only be colored red if the terminal supports colors'));
Any kleur
method returns a String
(when invoked, not chained). It's up to the developer to pass the output to destinations like console.log
, process.stdout.write
, etc.
The methods below are grouped by type for legibility purposes only. They each can be chained or nested with one another.
Colors:
black — red — green — yellow — blue — magenta — cyan — white — gray
Backgrounds:
bgBlack — bgRed — bgGreen — bgYellow — bgBlue — bgMagenta — bgCyan — bgWhite
Modifiers:
reset — bold — dim — italic* — underline — inverse — hidden — strikethrough*
* Not widely supported
Using Node v8.9.0
chalk: 9.372ms
turbocolor: 0.526ms
ansi-colors: 0.851ms
kleur: 0.862ms
# All Colors
ansi-colors x 60,485 ops/sec ±0.63% (96 runs sampled)
chalk x 7,184 ops/sec ±3.77% (68 runs sampled)
turbocolor x 95,468 ops/sec ±0.60% (94 runs sampled))
kleur x 151,365 ops/sec ±0.22% (95 runs sampled)
# Stacked colors
ansi-colors x 13,754 ops/sec ±0.44% (93 runs sampled)
chalk x 1,732 ops/sec ±3.76% (71 runs sampled)
turbocolor x 28,709 ops/sec ±1.32% (92 runs sampled)
kleur x 30,837 ops/sec ±0.13% (93 runs sampled)
# Nested colors
ansi-colors x 28,898 ops/sec ±0.32% (96 runs sampled)
chalk x 3,389 ops/sec ±4.03% (71 runs sampled)
turbocolor x 48,034 ops/sec ±1.47% (99 runs sampled)
kleur x 61,266 ops/sec ±0.33% (97 runs sampled)
This project was originally inspired by Brian Woodward's awesome ansi-colors
project.
Unlike v1, the latest version(s) of kleur
no longer supports:
\n
or \r
kleur.clear()
methodIn addition, kleur
continues to be ship without symbols and bright color variants.
If you need any of these features, please use ansi-colors
instead~!
MIT © Luke Edwards
FAQs
The fastest Node.js library for formatting terminal text with ANSI colors~!
The npm package kleur receives a total of 18,269,759 weekly downloads. As such, kleur popularity was classified as popular.
We found that kleur demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A record 2,709 developers participated in the 2024 Ruby on Rails Community Survey, revealing key tools, practices, and trends shaping the Rails ecosystem.
Security News
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.